Welcome
Workflow API
Workflow Element
Embed Enhancements
Getting Started With the API
Categories
Accounts
Zap Templates
Authentications
Experimental
Schemas
- Common Types
Categories
Accounts
Zap Templates
Authentications
Experimental
Get Zaps [v2]
This endpoint returns a list of Zaps for the authenticated Zapier user.
The expand
array can be used to expand selected fields into full objects in the response. Inputs with keys can
also be passed to filter Zaps by certain criteria.
OAuth
This endpoint requires the zap
, zap:all
, or zap:account:all
OAuth scope.
curl --request GET \
--url https://api.zapier.com/v2/zaps \
--header 'Authorization: Bearer <token>'
[
{
"data": [
{
"id": "00000000-0000-c000-8000-000000012345",
"type": "zap",
"links": {
"html_editor": "https://zapier.com/webintent/edit-zap/00000000-0000-c000-8000-000000012345"
},
"steps": [
{
"action": "uag:1f188536-6dd0-4172-8414-2b90914ddee9",
"inputs": {
"deal_stage": "CLOSED_WON"
},
"authentication": "b3eYnwl"
},
{
"action": "uag:1f188536-6dd0-4172-8414-2b90914ddaa7",
"inputs": {
"full_name": "{{customer__full_name}}"
},
"authentication": "BRn9rRg"
}
],
"title": "My Zap",
"is_enabled": false,
"updated_at": "2019-08-24T14:15:22Z",
"last_successful_run_date": "2019-08-24T14:15:22Z"
}
],
"meta": {
"count": 133,
"limit": 10,
"offset": 10
},
"links": {
"next": "https://api.zapier.com/v2/zaps?offset=20&limit=10",
"prev": "https://api.zapier.com/v2/zaps?offset=0&limit=10"
}
}
]
This API is rate limited.
Authorizations
See our OAuth2 authentication documentation
Query Parameters
A comma separated list of Zap fields that should be expanded from ids to full objects in the response. Fields that may not be expanded will remain as ids.
If true, all Zaps that are shared with the user, rather than only those owned by them, are returned. If the zap:account:all scope is not present this has no effect.
You may pass inputs[KEY]=VALUE1,VALUE2 to filter for Zaps that contain those settings. Keys are defined by your app on the developer platform.
Used for paginating results. Specifies the maximum number of items to return per page. If this value is not set, it defaults to 10.
Used for paginating results. Specifies the offset to use.
Response
A unique identifier of the Zap.
The date/time at which this Zap last ran successfully. A null value indicates that a Zap has never run successfully.
ExpandedZapStep (Expandable)
Action (Expandable)
The type of this Action
READ
- READWRITE
- WRITE
action
Apps (Expandable)
A list of categories to which this app belongs. Helpful in identifying apps by type and functionality.
Human readable description of the app.
A branded color that can be used to represent the app.
Unique id of the app
Default image/icon to represent the app.
Images/icons of various resolutions to represent the app.
A url that, when visited, will direct the user to authenticate with the app and allow Zapier access to the app, thus creating a new Authentication.
If value is `null`, then no authentication is required to use the app.
Human readable name of the app
The type of this object.
A longer description of this Action, usually describing what it does in more detail.
Will be set to true
if this Action triggers instantly. May only be true
when type
is READ
.
The developer provided identifier for this Action
The title of this Action.
The type of this object
action
- action
action
Authentication (Expandable)
An app that integrates with Zapier. (Expandable)
A list of categories to which this app belongs. Helpful in identifying apps by type and functionality.
Human readable description of the app.
A branded color that can be used to represent the app.
Unique id of the app
Default image/icon to represent the app.
Images/icons of various resolutions to represent the app.
A url that, when visited, will direct the user to authenticate with the app and allow Zapier access to the app, thus creating a new Authentication.
If value is `null`, then no authentication is required to use the app.
Human readable name of the app
The type of this object.
If true
, this Authentication has expired. It will not be usable, and the user needs to be directed to reconnect it.
The type of this object.
authentication
- authentication
authentication
The custom title of a Zap Step. If a step has not been given a custom title by the user, then the value will be null.
The human readable name of the Zap.
The type of this object.
Whether the Zap is enabled (running) or not.
curl --request GET \
--url https://api.zapier.com/v2/zaps \
--header 'Authorization: Bearer <token>'
[
{
"data": [
{
"id": "00000000-0000-c000-8000-000000012345",
"type": "zap",
"links": {
"html_editor": "https://zapier.com/webintent/edit-zap/00000000-0000-c000-8000-000000012345"
},
"steps": [
{
"action": "uag:1f188536-6dd0-4172-8414-2b90914ddee9",
"inputs": {
"deal_stage": "CLOSED_WON"
},
"authentication": "b3eYnwl"
},
{
"action": "uag:1f188536-6dd0-4172-8414-2b90914ddaa7",
"inputs": {
"full_name": "{{customer__full_name}}"
},
"authentication": "BRn9rRg"
}
],
"title": "My Zap",
"is_enabled": false,
"updated_at": "2019-08-24T14:15:22Z",
"last_successful_run_date": "2019-08-24T14:15:22Z"
}
],
"meta": {
"count": 133,
"limit": 10,
"offset": 10
},
"links": {
"next": "https://api.zapier.com/v2/zaps?offset=20&limit=10",
"prev": "https://api.zapier.com/v2/zaps?offset=0&limit=10"
}
}
]